<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">











<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <title>Maven Overview Plugin - maven-overview-plugin - overview:overview</title>
    <style type="text/css" media="all">
      @import url("./css/maven-base.css");
      @import url("./css/maven-theme.css");
      @import url("./css/site.css");
    </style>
    <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
        <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
      </head>
  <body class="composite">
    <div id="banner">
                    <span id="bannerLeft">
    
            Maven Overview Plugin
    
            </span>
                    <div class="clear">
        <hr/>
      </div>
    </div>
    <div id="breadcrumbs">
          
  

  
    
  
  
    
            <div class="xleft">
        Last Published: 2009-07-08
                      </div>
            <div class="xright">            <a href="http://github.com/neotyk/maven-overview-plugin/tree/master" class="externalLink">Source Tree</a>
            |
                <a href="">Maven Overview Plugin</a>
            |
                <a href="http://maven.apache.org/" class="externalLink">Maven 2</a>
            
  

  
    
  
  
    
  </div>
      <div class="clear">
        <hr/>
      </div>
    </div>
    <div id="leftColumn">
      <div id="navcolumn">
           
  

  
    
  
  
    
                   <h5>Overview</h5>
            <ul>
              
    <li class="none">
                    <a href="index.html">Introduction</a>
          </li>
              
    <li class="none">
                    <a href="plugin-info.html">Goals</a>
          </li>
              
    <li class="none">
                    <a href="usage.html">Usage</a>
          </li>
              
    <li class="none">
                    <a href="faq.html">FAQ</a>
          </li>
          </ul>
              <h5>Examples</h5>
            <ul>
              
    <li class="none">
                    <a href="examples/report.html">Report</a>
          </li>
              
    <li class="none">
                    <a href="examples/command.html">CommandLine</a>
          </li>
          </ul>
              <h5>Project Documentation</h5>
            <ul>
              
                
              
      
            
      
            
      
            
      
            
      
            
      
            
      
            
      
              
        <li class="collapsed">
                    <a href="project-info.html">Project Information</a>
                </li>
              
                
              
      
            
      
            
      
            
      
            
      
            
      
            
      
            
      
            
      
            
      
            
      
            
      
              
        <li class="collapsed">
                    <a href="project-reports.html">Project Reports</a>
                </li>
          </ul>
                                           <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
            <img alt="Built by Maven" src="./images/logos/maven-feather.png"></img>
          </a>
                       
  

  
    
  
  
    
        </div>
    </div>
    <div id="bodyColumn">
      <div id="contentBox">
        <div class="section"><h2><a name="overview:overview"></a>overview:overview</h2>
<p><strong>Note</strong>: This Mojo should be used as a Maven report.</p>
<p><strong>Full name</strong>:</p>
<p>com.googlecode.maven-overview-plugin:maven-overview-plugin:1.7-SNAPSHOT:overview</p>
<p><strong>Description</strong>:</p>
<p>Maven Overview Plugin. 

<p></p>
Generates overview graph of project dependencies.</p>
<p><strong>Attributes</strong>:</p>
<ul><li>Requires a Maven 2.0 project to be executed.</li>
<li>Binds by default to the lifecycle phase: <code>site</code>.</li>
</ul>
<div class="section"><h3><a name="Optional_Parameters"></a>Optional Parameters</h3>
<table class="bodyTable"><tr class="a"><th>Name</th>
<th>Type</th>
<th>Since</th>
<th>Description</th>
</tr>
<tr class="b"><td><strong><a href="#exclusions">exclusions</a></strong></td>
<td><code>List</code></td>
<td><code>-</code></td>
<td>Exclusions configuration. 

<p></p>
<pre>
&lt;exclusions&gt;
&lt;exclusion&gt; &lt;!-- all info provided, all have to match to exclude --&gt;
&lt;groupId&gt;groupRegExp&lt;/groupId&gt;
&lt;artifactId&gt;artivaftRegExp&lt;/artifactId&gt;
&lt;packaging&gt;packaginRegExp&lt;/packaging&gt;
&lt;version&gt;versionRegExp&lt;/version&gt;
&lt;scope&gt;scopeRegExp&lt;/scope&gt;
&lt;/exclusion&gt;
&lt;exclusion&gt; &lt;!-- only one provided --&gt;
&lt;scope&gt;scopeRegExp&lt;/scope&gt;
&lt;/exclusion&gt;
&lt;/exclusions&gt;
</pre></td>
</tr>
<tr class="a"><td><strong><a href="#height">height</a></strong></td>
<td><code>int</code></td>
<td><code>-</code></td>
<td>Rendered graph height in pixels. Default value is: <code>1200</code>.</td>
</tr>
<tr class="b"><td><strong><a href="#includes">includes</a></strong></td>
<td><code>String</code></td>
<td><code>-</code></td>
<td>GroupIDs of artifacts to be included. 

<p></p>
Coma separated list of included artifacts GroupIDs. </td>
</tr>
<tr class="a"><td><strong><a href="#localRepository">localRepository</a></strong></td>
<td><code>ArtifactRepository</code></td>
<td><code>-</code></td>
<td>Local Maven repository. </td>
</tr>
<tr class="b"><td><strong><a href="#maxDepth">maxDepth</a></strong></td>
<td><code>int</code></td>
<td><code>-</code></td>
<td>Maximum depth to pursue transitive dependencies 

<p></p>
</td>
</tr>
<tr class="a"><td><strong><a href="#project">project</a></strong></td>
<td><code>MavenProject</code></td>
<td><code>-</code></td>
<td>Maven Project. Default value: ${project} </td>
</tr>
<tr class="b"><td><strong><a href="#scopes">scopes</a></strong></td>
<td><code>String[]</code></td>
<td><code>-</code></td>
<td>If specified, only the specified scopes are pursued when traversing
the dependency tree 

<p></p>
</td>
</tr>
<tr class="a"><td><strong><a href="#showVersion">showVersion</a></strong></td>
<td><code>boolean</code></td>
<td><code>-</code></td>
<td>Show version in graph. As <a href="http://code.google.com/p/maven-overview-plugin/issues/detail?id=16" class="externalLink">
requested</a>. Default value is: <code>false</code>.</td>
</tr>
<tr class="b"><td><strong><a href="#suppressedScopes">suppressedScopes</a></strong></td>
<td><code>String</code></td>
<td><code>-</code></td>
<td>Suppressed scopes. 

<p></p>
Scopes that are not supposed to be shown on graph as edge
labels. 

<p></p>
 Default value is: <code>compile</code>.</td>
</tr>
<tr class="a"><td><strong><a href="#vertexFullLabel">vertexFullLabel</a></strong></td>
<td><code>boolean</code></td>
<td><code>-</code></td>
<td>Should vertex name be full artifact ID. Default value is: <code>false</code>.</td>
</tr>
<tr class="b"><td><strong><a href="#width">width</a></strong></td>
<td><code>int</code></td>
<td><code>-</code></td>
<td>Rendered graph width in pixels. Default value is: <code>1200</code>.</td>
</tr>
</table>
</div>
<div class="section"><h3><a name="Parameter_Details"></a>Parameter Details</h3>
<p><strong><a name="exclusions">exclusions</a>:</strong></p>
<p>Exclusions configuration. 

<p></p>
<pre>
&lt;exclusions&gt;
&lt;exclusion&gt; &lt;!-- all info provided, all have to match to exclude --&gt;
&lt;groupId&gt;groupRegExp&lt;/groupId&gt;
&lt;artifactId&gt;artivaftRegExp&lt;/artifactId&gt;
&lt;packaging&gt;packaginRegExp&lt;/packaging&gt;
&lt;version&gt;versionRegExp&lt;/version&gt;
&lt;scope&gt;scopeRegExp&lt;/scope&gt;
&lt;/exclusion&gt;
&lt;exclusion&gt; &lt;!-- only one provided --&gt;
&lt;scope&gt;scopeRegExp&lt;/scope&gt;
&lt;/exclusion&gt;
&lt;/exclusions&gt;
</pre></p>
<ul><li><strong>Type</strong>: <code>java.util.List</code></li>
<li><strong>Required</strong>: <code>No</code></li>
</ul>
<hr />
<p><strong><a name="height">height</a>:</strong></p>
<p>Rendered graph height in pixels.</p>
<ul><li><strong>Type</strong>: <code>int</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${height}</code></li>
<li><strong>Default</strong>: <code>1200</code></li>
</ul>
<hr />
<p><strong><a name="includes">includes</a>:</strong></p>
<p>GroupIDs of artifacts to be included. 

<p></p>
Coma separated list of included artifacts GroupIDs.</p>
<ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${includes}</code></li>
</ul>
<hr />
<p><strong><a name="localRepository">localRepository</a>:</strong></p>
<p>Local Maven repository.</p>
<ul><li><strong>Type</strong>: <code>org.apache.maven.artifact.repository.ArtifactRepository</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${localRepository}</code></li>
</ul>
<hr />
<p><strong><a name="maxDepth">maxDepth</a>:</strong></p>
<p>Maximum depth to pursue transitive dependencies 

<p></p>
</p>
<ul><li><strong>Type</strong>: <code>int</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${maxDepth}</code></li>
</ul>
<hr />
<p><strong><a name="project">project</a>:</strong></p>
<p>Maven Project. Default value: ${project}</p>
<ul><li><strong>Type</strong>: <code>org.apache.maven.project.MavenProject</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${project}</code></li>
</ul>
<hr />
<p><strong><a name="scopes">scopes</a>:</strong></p>
<p>If specified, only the specified scopes are pursued when traversing
the dependency tree 

<p></p>
</p>
<ul><li><strong>Type</strong>: <code>java.lang.String[]</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${scopes}</code></li>
</ul>
<hr />
<p><strong><a name="showVersion">showVersion</a>:</strong></p>
<p>Show version in graph. As <a href="http://code.google.com/p/maven-overview-plugin/issues/detail?id=16" class="externalLink">
requested</a>.</p>
<ul><li><strong>Type</strong>: <code>boolean</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${showVersion}</code></li>
<li><strong>Default</strong>: <code>false</code></li>
</ul>
<hr />
<p><strong><a name="suppressedScopes">suppressedScopes</a>:</strong></p>
<p>Suppressed scopes. 

<p></p>
Scopes that are not supposed to be shown on graph as edge
labels. 

<p></p>
</p>
<ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${suppressedScopes}</code></li>
<li><strong>Default</strong>: <code>compile</code></li>
</ul>
<hr />
<p><strong><a name="vertexFullLabel">vertexFullLabel</a>:</strong></p>
<p>Should vertex name be full artifact ID.</p>
<ul><li><strong>Type</strong>: <code>boolean</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${vertexFullLabel}</code></li>
<li><strong>Default</strong>: <code>false</code></li>
</ul>
<hr />
<p><strong><a name="width">width</a>:</strong></p>
<p>Rendered graph width in pixels.</p>
<ul><li><strong>Type</strong>: <code>int</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${width}</code></li>
<li><strong>Default</strong>: <code>1200</code></li>
</ul>
</div>
</div>

      </div>
    </div>
    <div class="clear">
      <hr/>
    </div>
    <div id="footer">
      <div class="xright">&#169;  
          2008-2009
    
          Agile Java
          
  

  
    
  
  
    
  </div>
      <div class="clear">
        <hr/>
      </div>
    </div>
  </body>
</html>
